|
Eclipse Platform Pre-release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A synchronize participant provides a logical connection between local resources and a remote location that is used to share those resources. The Synchronize View displays synchronize participants.
A participant must create a page that will be displayed in the ISynchronizeView page book view. Clients may implement this interface.
ISynchronizeView
,
ISynchronizeManager
Method Summary | |
void |
addPropertyChangeListener(IPropertyChangeListener listener)
Adds a listener for changes to properties of this synchronize participant. |
IPageBookViewPage |
createPage(ISynchronizeView view)
Creates and returns a new page for this synchronize participant. |
void |
dispose()
Disposes of this synchronize participant. |
String |
getId()
Returns the unique id that identified the type of this synchronize participant. |
ImageDescriptor |
getImageDescriptor()
Returns an image descriptor for this synchronize participant, or null
if none. |
String |
getName()
Returns the name of this synchronize participant. |
void |
init(IMemento memento)
Initializes this participant with the given participant state. |
void |
removePropertyChangeListener(IPropertyChangeListener listener)
Removes the given property listener from this synchronize participant. |
void |
saveState(IMemento memento)
Saves the participants object state within the memento. |
Methods inherited from interface org.eclipse.core.runtime.IExecutableExtension |
setInitializationData |
Method Detail |
public String getId()
public String getName()
public ImageDescriptor getImageDescriptor()
null
if none.
null
if nonepublic IPageBookViewPage createPage(ISynchronizeView view)
view
- the view in which the page is to be created
public void init(IMemento memento) throws PartInitException
This method is automatically called by the team plugin shortly after participant construction. It marks the start of the views's lifecycle. Clients must not call this method.
memento
- the participant state or null
if there
is no previous saved state
PartInitException
- if this participant was not initialized
successfullypublic void dispose()
ISynchronizeParticipant
. It marks the end of the
participants lifecycle.
Within this method a participant may release any resources, fonts, images, etc. held by this part. It is also very important to deregister all listeners.
Clients should not call this method (the synchronize manager calls this method at appropriate times).
public void saveState(IMemento memento)
init
.
memento
- a memento to receive the object statepublic void addPropertyChangeListener(IPropertyChangeListener listener)
The changes supported by the synchronize view are as follows:
IBasicPropertyConstants.P_TEXT
- indicates the name
of a synchronize participant has changedIBasicPropertyConstants.P_IMAGE
- indicates the
image of a synchronize participant has changedClients may define additional properties as required.
listener
- a property change listenerpublic void removePropertyChangeListener(IPropertyChangeListener listener)
listener
- a property listener
|
Eclipse Platform Pre-release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |